Bug fix for Entity description not surfaced in GraphQL. - #3732
Merged
anushakolan merged 7 commits intoJul 30, 2026
Conversation
anushakolan
marked this pull request as ready for review
July 21, 2026 20:39
anushakolan
requested review from
Alekhya-Polavarapu,
Aniruddh25,
JerryNixon,
RubenCerna2079,
aaronburtle,
rusamant,
sourabh1007,
souvikghosh04,
stuartpa and
vadeveka
as code owners
July 21, 2026 20:39
Contributor
There was a problem hiding this comment.
✅ Ready to approve
The change is small, targeted, and includes a regression unit test that directly validates the reported behavior.
Note: this review does not count toward required approvals for merging.
Pull request overview
This PR fixes GraphQL schema documentation for stored-procedure execute* fields by using the configured entity description (when provided) instead of always emitting a hardcoded description string, aligning schema docs with runtime config and the GraphQL description spec.
Changes:
- Updated stored-procedure GraphQL field generation to prefer
entity.Description, with the previous hardcoded text as a fallback. - Added a unit test to prevent regressions by asserting the
execute*field description matches the configured entity description.
File summaries
| File | Description |
|---|---|
| src/Service.GraphQLBuilder/GraphQLStoredProcedureBuilder.cs | Uses entity.Description for the stored-procedure execute* field description, falling back to the previous hardcoded text when absent. |
| src/Service.Tests/GraphQLBuilder/Sql/StoredProcedureBuilderTests.cs | Adds a regression test validating the execute* field description uses the entity-level description from config. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Low
Note
Your feedback helps us improve the quality of this feature.
Please use 👍 or 👎 to tell us whether this assessment is correct.
anushakolan
changed the title
RubenCerna2079
approved these changes
Jul 22, 2026
RubenCerna2079
left a comment
RubenCerna2079
left a comment
Contributor
There was a problem hiding this comment.
LGTM! Just a question to address
https://github.com/Azure/data-api-builder into dev/anushakolan/issue-3499-graphql-entity-description
RubenCerna2079
enabled auto-merge (squash)
July 30, 2026 18:51
RubenCerna2079
disabled auto-merge
July 30, 2026 18:51
anushakolan
deleted the
dev/anushakolan/issue-3499-graphql-entity-description
branch
July 30, 2026 21:21
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why make this change?
What is this change?
entity.Descriptionwhen present, with the existing hardcoded text retained as a fallback.How was this tested?
Sample Request(s)
dab start --config "dab-config.json"